CxBssEditor Methods
The CxBssEditor object contains the following methods:
Connect
The Connect method connects to a BSS.
Syntax
Connect(DomainSiteService As String)
Parameters
| Parameter | Required | Description |
|---|---|---|
|
DomainSiteService |
Yes |
The [Domain]Site.Service to which to connect. A domain is optional. The service must be a valid BSS. |
Example
The following example creates and connects the CxBssEditor object.
|
Sub Dim BssEditor Set BssEditor = CreateObject("CxEditors.CxBssEditor") BssEditor.Connect("[5410]CYGDEMO.BSS") End Sub |
Copy
This method is unimplemented.
Delete
The Delete method launches a Delete Entry dialog box for the specified record.
Syntax
Delete(QueueKey As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to delete. |
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a Delete Entry dialog box for record "0000000157."
|
Sub Dim iRet iRet = BssEditor.Delete("0000000157") MsgBox iRet End Sub |
Disconnect
The Disconnect method disconnects from the connected BSS.
Syntax
Disconnect()
Example
The following example disconnects the BssEditor object.
|
Sub BssEditor.Disconnect End Sub |
DownloadBlob
The DownloadBlob method prompts the user to download the specified BLOB to a selected folder.
Syntax
DownloadBlob(QueueKey As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to download. |
Remarks
This method returns a 1 if the file was successfully downloaded, otherwise it returns a 0.
Example
The following example prompts the user to download the BLOB with queue key "0000000157."
|
Sub Dim iRet iRet = BssEditor.DownloadBlob("0000000157") MsgBox iRet End Sub |
Edit
The Edit method launches a property sheet initialized with the information in the specified record.
Syntax
Edit(QueueKey As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to edit. |
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
OK button was pressed. | |
| 2 | Cancel button was pressed. |
Example
The following example launches a property sheet for record "0000000157."
|
Sub Dim iRet iRet = BssEditor.Edit("0000000157") MsgBox iRet End Sub |
New
The New method launches a dialog box that is used to upload files to a BLOB folder.
Syntax
New() As Integer
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
Files were uploaded successfully | |
| 2 |
No files were uploaded. |
Example
The following example prompts the user to upload a file to a BLOB folder.
|
Sub Dim iRet iRet = BssEditor.New MsgBox iRet End Sub |
ReplaceBlob
The ReplaceBlob method prompts the user to replace the specified BLOB with a selected file of the same name.
Syntax
ReplaceBlob(QueueKey As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to replace. |
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
The BLOB was successfully replaced. | |
| 2 |
Cancel button was pressed. |
Note that it is only possible to replace a BLOB with a file of the same name using this method.
Example
The following example prompts the user to replace the BLOB with queue key "0000000157."
|
Sub Dim iRet iRet = BssEditor.ReplaceBlob("0000000157") MsgBox iRet End Sub |
TouchBlob
The TouchBlob method updates the file time for the specified BLOB.
Syntax
TouchBlob(QueueKey As String) As Integer
Parameters
| Parameter | Required | Description |
|---|---|---|
|
QueueKey |
Yes |
The database queue key of the record to touch. |
Remarks
This method returns one of the following values:
| -1 or 0 | An error occurred. | |
|
1 |
The BLOB file time was successfully updated. |
Note that it is only possible to replace a BLOB with a file of the same name using this method.
Example
The following example prompts the user to touch the BLOB with queue key "0000000157."
|
Sub Dim iRet iRet = BssEditor.TouchBlob("0000000157") MsgBox iRet End Sub |
